Bentley i-model Composition Server for PDF Help

Running Jobs Automatically Using a Schedule

After you create a job and run it manually at least once to ensure you are getting the expected results, you can set up a schedule to have the job run automatically.

Job schedules are created and edited using the Schedule Job wizard. You can set up how often a job is to run (hourly, daily, weekly, monthly), whether to run it in full or incrementally, specific start times, and the user name and password for the scheduled job.

The user name and password that you specify when setting up the schedule needs to be a valid user name and password for an account on the computer on which Bentley i-model Composition Server for PDF is installed. This user name and password sets the security context in which the job can run. Another user cannot remove the job from the schedule unless the user has the correct user name and password.

Before you can schedule jobs:

  • The Windows Task Scheduler service must be started on the computer on which Bentley i-model Composition Server for PDF is installed.
  • If scheduling jobs remotely, the Windows Remote Registry service must be started on the computer on which Bentley i-model Composition Server for PDF is installed.
  • If scheduling jobs remotely, the user scheduling jobs must have administrative privileges on the computer on which Bentley i-model Composition Server for PDF is installed.

The Job Scheduler window lists all scheduled jobs. You can edit or delete any schedules listed.

A job that is scheduled to run incrementally can be reset at any time, so that the next time it runs it will be run in full, as if it were the first time being run. This also clears the job's history.

Start the Windows Task Scheduler and the Remote Registry Service

  1. Open the Services window (Control Panel > Administrative Tools > Services).
  2. Right-click Task Scheduler and select Start.
  3. Right-click Remote Registry and select Start.

Create a predefined user for job schedules

Each job schedule you create requires that you specify a valid domain account or local account that exists on the server that can be used to start jobs. This account will be used to start the job when the schedule is due. When specifying which account to use, you can either directly enter the user name and password of the required account, or you can select the name of a predefined user from a list, where the user name and password have already been defined. Creating one or more predefined users in advance makes it easier for anyone creating job schedules; instead of having to know/remember what user name and password to supply, you can simply select the name of a predefined user from a list.

  1. Open the Job Scheduler window (Tools > Job Scheduler).
  2. Click the ... button.
  3. In the Job Schedule Users dialog, click the Add New User icon .
  4. In the New Schedule User dialog:
    1. In the Display Name field, enter a name for the user. This is the name you will select when specifying which account to use in a schedule.
    2. In the User Name field, enter the user name of a valid account on the server. If it is a domain account, the syntax is domain\user.name.
    3. In the Password field, enter the password of the account.
    4. In the Confirm Password field, reenter the password.
    5. Click OK.

    The user is added to the Job Schedule Users dialog.

  5. Click OK.

    The predefined user appears in the list of users in the Job Scheduler window.

    You can now use this user in a job schedule.

Note: The user account credentials are not validated when you create the predefined user. Instead, they are validated when you create the schedule. Therefore be careful when entering the user name and password for predefined users; if you enter them incorrectly, you will not be notified that the account is invalid until you attempt to use that account in a schedule. You will not be able to create the schedule if the credentials are invalid.

Create a schedule for running a job

  1. In the Bentley iCS for PDF Browser , select a job definition.
  2. Select Job > New Schedule.

    The Schedule Job wizard opens with the name of the selected job as the default name for the schedule.



  3. On the first page, do the following:
    1. Enter a name for the schedule, or leave the default name as is.
    2. Select how often you want the job to run:
      • Hourly
      • Daily
      • Weekly
      • Monthly
      • One time only
    3. Select whether this schedule will initiate a Full or Incremental run of the job.
    4. Click Next.
    Note: If you need to use the period character (".") in your schedule name, there must be at least four characters after the period.

    The second page lets you specify the time and day to start the job. The options available on this page depend on how often you selected the job to run on the previous page.



  4. On the second page, do the following:
    1. If you selected Hourly, select how often the job is to run (every so many hours and minutes), then specify the start date. Hourly jobs always start at midnight (12:00 a.m.) on the specified start date.
    2. If you selected Daily, specify the start time, select how often the job is to run (every day, every weekday, or every so many days) then specify the start date.
    3. If you selected Weekly, specify the start time, select how often the job is to run (every so many weeks), then specify on which day(s) of the week the job is to run.
    4. If you selected Monthly, specify the start time, select which day of the month the job is to run, and on which month(s) of the year the job is to run.
    5. If you selected One time only, specify the start time and the start date.
    6. Click Next.

    The third and final page that opens is used to specify which user account will be used to start the job. You can either select a predefined user or specify a user name and password. Whichever you use, the user must be a valid domain or local account that exists on the Bentley i-model Composition Server for PDF computer.



  5. On the third page, do the following:
    1. Select Use a predefined user, then select a user from the list. You can also click the ... button to create and add a new predefined user to the list.

      or

    2. Select Define a user for this job, then enter a user name and password.
    3. Click Finish.
Note: Entering invalid user credentials, or selecting a predefined user that has invalid user credentials, will prevent the schedule from being created.

Edit a job schedule

  1. Open the Job Scheduler window (Tools > Job Scheduler).
  2. Select a job from the list and click Edit scheduled job .
  3. The Schedule Job wizard opens.


  4. You can edit any details about the schedule except for the name.

Reset a scheduled job

  1. In the Bentley iCS for PDF Browser, select a job definition.
  2. Right-click the job definition and select Reset Job.

    or

    Select the job definition and either select Job > Reset Job or click the Reset Job icon on the toolbar.

    A message opens, informing you that all the documents in the input set will be processed the next time the job is run.

  3. Click OK.

Delete a job schedule

  1. Open the Job Scheduler window (Tools > Job Scheduler).
  2. Select a job from the list.
  3. Click the Delete scheduled job icon.

    The selected job schedule is removed from the Job Scheduler window.

Parent topic: Running Jobs